home *** CD-ROM | disk | FTP | other *** search
/ Delphi Programmer's Power Pack / Delphi Volume 1.iso / s_to_z / ssbc15 / manual.txt < prev    next >
Text File  |  1996-09-15  |  15KB  |  263 lines

  1. ssBarCode version 1.5
  2. The Delphi Native Bar code Component - 16-bit version
  3.  
  4. Soft Sector, Inc.
  5. PO Box 81480
  6. Cleveland OH 44181
  7.  
  8. See the document ORDER.TXT for ordering information.
  9.  
  10. See the end of this document for the new features in this version.
  11.  
  12. Introduction
  13. Thank you for your interest in our bar coding VCL.  There are many bar coding products for developers in existence, but all are either in DLL or VBX form.  With the release of ssBarCode from Soft Sector, Inc., developers now have a Delphi-native option to implement bar coding into their applications.
  14.  
  15. In this first version, ssBarCode supports the four most popular bar code symbologies:  Code 39 (or 3 of 9), Interleaved 2 of 5, Postnet, and UPC version A.  In the near future we will be implementing many more symbologies.  Please see the section of this file entitled "Future Enhancements."
  16.  
  17. About Soft Sector, Inc.
  18. Soft Sector, Inc. (SSI) is a Cleveland, OH based provider of hardware and software solutions.  Our main language for development is Borland Delphi.  In the course of our application development, we have created a number of components and tools that would be useful to other developers.  We are in the process of packaging these components for retail distribution.
  19.  
  20. Contacting Soft Sector, Inc.
  21. We can be contacted in a variety of ways:
  22.  
  23. US Mail:  Soft Sector, Inc., PO Box 81480, Cleveland, OH 44181 USA
  24. E-Mail:  ssi@en.com
  25. Phone/fax:  (216) 777-3612
  26.  
  27. Keep an eye out for our Web page, coming soon!
  28.  
  29. Installation
  30. You can install ssBarCode as you would any other component.  Specifically, follow these steps:
  31.  
  32. 1.  Place all files that were contained in the .ZIP file into a directory (example:  \SSBC)
  33.  
  34. 2.  Go into Delphi and access the OPTIONS pulldown menu.  Then choose INSTALL COMPONENTS...
  35.  
  36. 3.  Click on the ADD button.  Another dialog box will pop up.  Click on the BROWSE button.
  37.  
  38. 4.  A file selection common dialog will pop up.  Select the directory where you put the ssBarCode files.  In the "List Files of Type" drop down, you should select "DCU" files.
  39.  
  40. 5.  You will see "SSBC.DCU" appear in the files list box.  Select it and click OK.
  41.  
  42. 6.  Now click OK in the Install Components dialog box.  DelphiÆs VCL will now recompile.  When itÆs done, you should have a palette page named "Soft Sector".  On it will appear an icon for the ssBarCode component.
  43.  
  44. ThatÆs all there is to it!  YouÆre now ready to start creating bar codes!
  45.  
  46. Note that this restricted version of ssBarCode will only run while the Delphi IDE is running.  That means in order to include it in your applications, you must pay the registration fee!  See the file ORDER.TXT for more information on this extremely useful, yet affordable product.
  47.  
  48. Demo Program
  49. WeÆve written a simple demo program to show off some of the features of ssBarcode, including the different symbologies, bar width specification, and barcode printing.  The project name is DEMOBC.DPR.  All of the features of this demo program are very easy to understand, and some of the code is commented.
  50.  
  51. Properties 
  52. AutoSize
  53. BarCodeType
  54. BarColor
  55. BarWidth
  56. BearerBars
  57. CalcCheckDigit
  58. Canvas (*)
  59. Color (*)
  60. Data
  61. Orientation
  62. PrintHumanReadable
  63. Visible (*)
  64. WideBarRatio
  65.  
  66. (*)  These are inherited properties that are not described in this document.  See the Delphi help file for details.
  67.  
  68. AutoSize property
  69.  
  70. Declaration
  71. property AutoSize : boolean
  72.  
  73. Description
  74. The AutoSize property will automatically size the bar code to certain proportions based a number of calculations.  The first factor is the BarWidth property; the width of the component will be the BarWidth property times the actual number of bars and spaces.  The height of the component will be based on the standard accepted height to width ratio for each symbology.
  75.  
  76. If you set AutoSize to false, you can size the component as you see fit.  However, there is no guarantee that the resulting code will fit in the space you allot.
  77.  
  78. BarCodeType property
  79.  
  80. Declaration
  81. property BarCodeType : TBarCodeType 
  82.  
  83. Description
  84. This is the main property of the component.  It defines which symbology you want to use to create the bar code.  The possible values for TBarCodeType are:
  85.  
  86. {bcCode39, bcInt2of5, bcPostnet, bcUPC_A}
  87.  
  88. See the section below entitled "Symbologies" for a more in-depth description of each symbology.  
  89. When you set the BarCodeType property, the program will check the Data property to see if the data entered is acceptable for the chosen bar code type.  For example, you cannot have alpha characters in an Interleaved 2 of 5 code.  If the data is not acceptable, an exception of type EBarCodeError will be raised.
  90.  
  91. BarColor property
  92.  
  93. Declaration
  94. property BarColor : TColor 
  95.  
  96. Description
  97. Use this property to set a color for the actual bars themselves as well as the human readable text beneath the bar code.  Note that for best scanning, bar codes should be black bars on a white background, but you do have the option to change this.
  98.  
  99. BarWidth property
  100.  
  101. Declaration
  102. property BarWidth : single 
  103.  
  104. Description
  105. This property allows you to change the width, in inches, of each bar.  For bar codes that have a narrow to wide bar ratio, the wide bar width is calculated based on the WideBarRatio property.  If you have the AutoSize property set to True, the component will resize when you change this property.
  106.  
  107. Each symbology has a standard accepted BarWidth, listed below.  Of course, these are only recommendations and you are free to use whatever width you choose.
  108.  
  109. Code 39 = 0.010 inches
  110. Interleaved 2 of 5 = 0.015 inches
  111. Postnet = 0.020 ** (We strongly recommend using this value for Postnet)
  112. UPC A = 0.013 inches
  113.  
  114.  
  115. BearerBars property
  116.  
  117. Declaration
  118. property BearerBars : boolean 
  119.  
  120. Description
  121. Certain bar code symbologies call for bearer bars, or horizontal lines that run along the top and bottom of the code.  The reason for these bars is that a partial scan can sometimes be interpreted as a complete scan.  Bearer bars greatly reduce the chance of this happening.  
  122.  
  123. As of version 1.0, only Interleaved 2 of 5 bar codes can have bearer bars.  The other symbologies do not need them.  If you try to set BearerBars equal to True for any other symbology, an EBarCodeError exception will be raised.
  124.  
  125. CalcCheckDigit property
  126.  
  127. Declaration
  128. property CalcCheckDigit : boolean 
  129.  
  130. Description
  131. Set this property to True if you want the component to automatically generate the check digit for UPC A bar codes.  If CalcCheckDigit is False, then you must provide all 12 digits of the UPC code in the Data property, or an exception will be raised.
  132.  
  133. Data property
  134.  
  135. Declaration
  136. property Data : string 
  137.  
  138. Description
  139. This property is where you set the actual data to be encoded.  Data for each bar code symbology must follow certain rules or an exception will be raised.  See the section below entitled "Symbologies" for a description of acceptable data for each type of bar code.
  140.  
  141. Orientation property
  142.  
  143. Declaration
  144. property Orientation : TOrientation 
  145.  
  146. Description
  147. The Orientation property is used to rotate the bar code in 90 degree increments.  You would never want to have a bar code that is not rotated in an increment of 90 degrees.  The human readable text is obviously also rotated.  The possible values for TOrientation are:
  148.  
  149. {orLeft_Right, orRight_Left, orTop_Bottom, orBottom_Top}
  150.  
  151. orLeft_Right means that the bar code is created from Left to Right (it is the default).  orTop_Bottom means that the bar code is created from Top to Bottom, etc.
  152.  
  153. PrintHumanReadable property
  154.  
  155. Declaration
  156. property PrintHumanReadable : boolean 
  157.  
  158. Description
  159. This property allows you to set whether the component will output the human readable version of the bar code (i.e. the actual letters or numbers).  Bar codes like UPC A should always have this set to True.  As for the other bar codes, it is completely up to you.
  160.  
  161. Note that, in this version, all human readable text is printed using the Courier font.
  162.  
  163. WideBarRatio property
  164.  
  165. Declaration
  166. property WideBarRatio : single
  167.  
  168. Description
  169. This property affects the narrow-to-wide bar ratio for symbologies that have